home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 1995 #1 / Amiga Plus 1995 #1.iso / fish-disketten / fish_851-860 / d851 / armyminer / armyminer.doc < prev    next >
Text File  |  1994-12-13  |  9KB  |  227 lines
  1.  
  2.  
  3.                                  ARMYMINER v1.0
  4.  
  5.                                  April 13, 1993
  6.  
  7.  
  8. Preface
  9. ~~~~~~~
  10.  
  11.      This program is public domain, binary only. You are free to use it as
  12. long as you leave my copyright notice intact. You can distribute this program
  13. as long as you don't ask any more money for it than a nominal fee for copying,
  14. and if you keep this document with it. If you want to include this program in
  15. a commercial package you need my written permission.
  16.  
  17.      If you have suggestions or remarks about this program, or if you find
  18. any bugs, please let me know.
  19.  
  20.      You can reach me at the following address:
  21.  
  22.                              Alain Laferriere
  23.                              5190 Drolet #1
  24.                              Montreal, Quebec, H2T 2H2
  25.                              Canada
  26.  
  27.                              Telephone: (514) 277-6668
  28.  
  29.      If you have access to Internet, you'll be able to reach me anytime at
  30.      the following address:
  31.  
  32.                       E-mail: laferrie@iro.umontreal.ca
  33.  
  34.      Since I read my mail everyday, you can expect a fast answer.
  35.  
  36.  
  37. Contents
  38. ~~~~~~~~
  39.  
  40. 1. Introduction
  41.  
  42. 2. Usage
  43.  
  44. 3. Bugs
  45.  
  46. 4. Job hunting
  47.  
  48. 5. Special thanks
  49.  
  50.  
  51. 1. Introduction
  52. ~~~~~~~~~~~~~~~
  53.  
  54.   Of all the Amiga versions of Minesweeper or X-Mines I've seen so far, none
  55. was complete enough to satisfy me. I felt that a program that would integrate
  56. all of the good features I've seen in different programs was needed. Also,
  57. the program architecture itself was offering a really interesting challenge so
  58. I decided to write my own.
  59.  
  60.   Armyminer v1.0 works under 1.3 and 2.0, either on PAL or NTSC. It requires
  61. no external libraries whatsoever.
  62.  
  63.   Armyminer was developped on Amiga 3000UX, with Manx Aztec C v5.2a, CED and
  64. Enforcer.
  65.  
  66.  
  67. 2. Usage
  68. ~~~~~~~~
  69.  
  70.   Armyminer can be started from the cli or by clicking its icon in the
  71. WorkBench environment. If first verifies if the stack is sufficient to
  72. handle worst case recursivity. If it's not the case then the following
  73. message is diplayed on screen (if run from CLI):
  74.  
  75.     Stack size is 12000 bytes
  76.     Stack must be at least 30000 bytes to run Armyminer
  77.  
  78.   When you start Armyminer from the cli, you can specify an initial seed
  79. value for the pseudo-random number generator. For example:
  80.  
  81.     Armyminer 25643
  82.  
  83.   That feature is really interesting for people who want to compete on the
  84. same boards, by setting the same seed value. Note however that when the
  85. "safe start" switch is enabled, the first clicked square will determine
  86. the board's initial configuation. So, if you want to compete with a friend
  87. you have to either turn that switch off (in which case the board's
  88. configuration will always be the same no matter which square is first
  89. clicked) or to both click on the same square to start the game.
  90. If no seed value is specified, the program calculates a new seed
  91. by using the current system's time.
  92.  
  93.   Armyminer possess 4 different game settings:
  94.  
  95.     BEGINNER MODE : 8 by 8 board, 15% (9) bombs
  96.  
  97.     ADVANCED MODE : 30 by 16 board, 21% (100) bombs
  98.  
  99.     EXPERT MODE   : 25 by 25 board, 24% (150) bombs
  100.  
  101.     CUSTOM MODE   : You select the board width, height and bomb percentage
  102.  
  103.   Armyminer starts in ADVANCED mode. These board settings are similar to
  104. the ones in the X-Window's XMines. You can start playing the game by
  105. clicking on any square, or choose a different setting by either selecting
  106. it in the menus (or by using the keyboard alternates) or by clicking on the
  107. corresponding gadget on screen.
  108.  
  109.   As you will notice, there is a PAUSE option which temporarily hides the
  110. board and pauses the timer. It's a very interesting feature as it lets you
  111. answer the phone (or eat a pizza slice) in the middle of a game, by example.
  112. That PAUSE options is only available when there is a game in progress. When
  113. it's not the case, the gadget is ghosted. When you select the "About" item
  114. when a game is in process, the timer is also paused so you can continue
  115. the game without loosing time.
  116.  
  117.   When the game window in inactivated, the counter temporarily pauses and
  118. restarts when the game is reactivated.
  119.  
  120.   Like in other minesweeper-type games available, you use the mouse in the
  121. following way:
  122.  
  123.   - Use left mouse button to click (push down) a square in the board
  124.   - Use right mouse button to toggle the state of a covered square
  125.   - Use right or left mouse button on an uncovered square to clean its
  126.     neighbours (when the number of marked squares in its neighbourhood is
  127.     the same as the number written on the uncovered square itself).
  128.  
  129.   In the OPTIONS menu, you'll find the following items:
  130.  
  131.   - Use question marks. Lets the user cycle the state of a covered square
  132.     (by clicking the right mouse button when the mouse pointer is over the
  133.     square) from unmarked, to marked (check mark symbol), to a question
  134.     mark ("?") to unmarked. When inactive, the square state is toggled from
  135.     unmarked to marked to unmarked. This option was available on the
  136.     IBM-compatible Minesweeper so I decided it would be nice to have it
  137.     here.
  138.  
  139.   - Safe start. Assures you that the first square you'll click when starting
  140.     a new game will have no bombs in its immediate neighbours. That way, you
  141.     are sure to clean a part of the board. When inactive, you have absolutely
  142.     no garantee to start a game safely and it's possible to explode on the
  143.     first click.
  144.  
  145.   - Auto mark. By clicking the left or right mouse button when the mouse pointer
  146.     is over an uncovered square, forces all its neighbours to be marked as bombs
  147.     when they are in equal number as the number written on the uncovered square
  148.     itself. That option makes the game a lot more easy.
  149.  
  150.   - Safe click. Forces the board squares to be treated as normal Amiga gadgets.
  151.     That means if you push a square and keep the left mouse button pressed,
  152.     then move the mouse, the square will return to its covered state. When this
  153.     option in turned off, moving the mouse will have no effect and the square
  154.     will be pushed anyway. The IBM-compatible Minesweeper reacts as having the
  155.     safe click option ON. Some players (like me) prefer to turn it off because
  156.     when you click squares rapidly (i.e. moving the mouse at the same time),
  157.     the gadget-like behavior will ignore some of the clicked squares and put
  158.     them back to their original covered state.
  159.  
  160.   - Sound effects. There is sound effects for pushing, popping, marking and
  161.     exploding a square, also there is a "good work son" played when your score
  162.     is good enough to enter the high-score table. You can turn them ON or OFF
  163.     with that option.
  164.  
  165.   The default settings of these options for each mode are:
  166.  
  167.       Mode     Use question marks    Safe start    Auto mark    Safe Click
  168.       ----     ------------------    ----------    ---------    ----------
  169.  
  170.     BEGINNER         ACTIVE            ACTIVE        ACTIVE       ACTIVE
  171.     ADVANCED        INACTIVE           ACTIVE       INACTIVE     INACTIVE
  172.      EXPERT         INACTIVE           ACTIVE       INACTIVE     INACTIVE
  173.      CUSTOM         INACTIVE           ACTIVE        ACTIVE      INACTIVE
  174.  
  175.   There are 4 high-scores tables (BEGINNER, ADVANCED, EXPERT, CUSTOM). The first
  176. three of those are ordered by timer values since the board dimensions remain
  177. the same in each. The custom high-score table entries are ordered in a
  178. different way. The "score" is calculated in regard to the board dimensions, the
  179. bomb percentage and the timer value.
  180.  
  181.   The SCORES menu possess the following items:
  182.  
  183.   - SHOW : Displays any of the high-scores table
  184.  
  185.   - CLEAR : Resets all the entries of any of the high-scores table
  186.  
  187.  
  188. 3. Bugs
  189. ~~~~~~~
  190.  
  191.   The only problem that remains is the string gadget behavior (when a user
  192. enters his name in the high-score table). Under 2.0, the gadget is
  193. autoactivated but under 1.3, the user must first click in it.
  194.  
  195.   Since I developped that program with Enforcer v37.25, there are no bad
  196. memory access problems for sure!
  197.  
  198.  
  199. 4. Job hunting
  200. ~~~~~~~~~~~~~~
  201.  
  202.   This is my first release of a game in the public domain. However, I wrote
  203. lots of other programs (tools, disk utilities, etc) for myself and friends
  204. and I am getting very comfortable with the Amiga computer.
  205.  
  206.   My next project is not yet decided but I think I'll go for a commercial
  207. shoot-em up development or maybe a really complete text processing tool.
  208. If there are any commercial software development companies listening out
  209. there, you have my address. If you need somebody to code stuff then you
  210. know how to contact me.
  211.  
  212.   I know that lots of european magazines put public domain software on their
  213. cover disks. If my program happens to appear on such a disk, I'll be very
  214. thankful to receive a copy of the magazine and to hear from anybody who
  215. likes my program and wants to discuss about it.
  216.  
  217.  
  218. 5. Special thanks
  219. ~~~~~~~~~~~~~~~~~
  220.  
  221.   Special thanks goes to my good friend Daniel Beaudry, who made the
  222. "About" menu's picture and other graphics. Also thanks to Pierre Rioux
  223. who did a wonderful job at sending bug reports and suggestions.
  224. Philippe Hebrais, Lucie Jolicoeur, Eric Prevot and Jocelyn Cloutier
  225. also played many games and gave me very good suggestions that were
  226. later included.
  227.